home *** CD-ROM | disk | FTP | other *** search
/ TeX 1995 July / TeX CD-ROM July 1995 (Disc 1)(Walnut Creek)(1995).ISO / dviware / xdvi / README < prev    next >
Text File  |  1994-05-23  |  16KB  |  390 lines
  1. DESCRIPTION
  2.  
  3. xdvi is a program for previewing .dvi files, which are produced by the
  4. mathematical typesetting system, TeX.
  5.  
  6. INSTALLATION INSTRUCTIONS
  7.  
  8. You can compile and install with either imake or just plain make.
  9.  
  10. To install with imake, do the following:
  11.  
  12.     1.    Set the OSDEFS flags in the Imakefile (see SETTING OSDEFS, below).
  13.  
  14.     2.  Set the OPTIONDEFS flags in the Imakefile (see COMPILATION OPTIONS,
  15.     below).
  16.  
  17.     3.    Set the font path options in the Imakefile (see SETTING THE FONT PATH,
  18.     below).
  19.  
  20.     4.    Make the Makefile:    xmkmf
  21.  
  22.     5.  Compile xdvi:        make
  23.     If you have problems, see COMMON PROBLEMS WHEN COMPILING, below.
  24.  
  25.     6.    Try out xdvi.  
  26.     If the settings in step 3 are incorrect, then you can use the
  27.     corresponding environment variables to quickly try out different
  28.     values.  Then rm font_open.o and go back to step 3.
  29.  
  30.     7.    Make xdvi.man
  31.  
  32.     8.    Install xdvi and xdvi.man.
  33.  
  34. Or, to install with plain make, do the following:
  35.  
  36.     0.    Copy Makefile.std to Makefile.
  37.  
  38.     1.    Set the OSDEFS flags in the Makefile (see SETTING OSDEFS, below).
  39.  
  40.     2.  Set the OPTIONDEFS flags in the Makefile (see COMPILATION OPTIONS,
  41.     below).
  42.  
  43.     3.    Set the font path options in the Makefile (see FONT PATH OPTIONS,
  44.     below).
  45.  
  46.     Then continue with steps 5-8 as above.
  47.  
  48.  
  49. SETTING OSDEFS
  50.  
  51.     The OSDEFS variable should contain definitions to indicate what type
  52.     of system you are using.  They may be some of the following:
  53.  
  54.     SYSV        Set for System V compilation.
  55.     VMS        Set for VMS compilation.
  56.     MSBITFIRST    Store bitmaps internally with the most significant bit
  57.             at the left.  For performance reasons, it would be best
  58.             to set this to coincide with what your server uses.
  59.             Use the keystroke '^P' to find information in this
  60.             regard.  Generally, you should use MSBITFIRST if and
  61.             only if '^P' reports bitord = 1, and BMSHORT/BMBYTE
  62.             (below) should be set to match whatever '^P' reports
  63.             under "Unit =".  But, if bitord = byteord, then the
  64.             latter setting should not matter much.
  65.     BMSHORT        Store bitmaps in short integers instead of 32-bit
  66.             integers.  See MSBITFIRST for other relevant comments.
  67.             To check performance, you can use:
  68.                 time xdvi -d 8 file.dvi
  69.     BMBYTE        Store bitmaps in bytes instead of 32-bit integers.
  70.  
  71.     The following table gives OSDEFS settings for some systems:
  72.  
  73.     Machine        O/S        OSDEFS
  74.     -------        ---        ------
  75.     DEC Alpha    OSF/1 2.0    OSDEFS=
  76.     Intel x86    Linux        OSDEFS=
  77.     NeXT        NeXTStep    OSDEFS=-DMSBITFIRST -DVFORK -Dpid_t=int
  78.     RS6000        AIX        OSDEFS=-DMSBITFIRST -DSVR3 -DSTREAMSCONN
  79.     SGI        IRIX 5.1    OSDEFS=-DMSBITFIRST -DSVR4
  80.                     (If not using imake, also add
  81.                     -cckr -float -KPIC -G 0 -Wf,-XNh2000
  82.                     to CFLAGS.)
  83.     Sun 3        Sunos 4.x    OSDEFS=-DMSBITFIRST -DVFORK
  84.                       or   -DMSBITFIRST -DVFORK=include
  85.     Sun Sparc    Sunos 4.x    OSDEFS=-DMSBITFIRST -DVFORK=include
  86.     Sun Sparc    Solaris        OSDEFS=-DMSBITFIRST -DSYSV
  87.  
  88.     If, when running xdvi, you will usually be displaying remotely
  89.     (e.g., on an X terminal), then you may want to set the BMSHORT/BMLONG
  90.     flags and the byte order to correspond to the most common display
  91.     device.
  92.  
  93.  
  94. COMPILATION OPTIONS
  95.  
  96.     The OPTIONDEFS variable should be set to indicate which options
  97.     xdvi should be compiled with.  These are listed below.
  98.  
  99.     There is really no difference between OSDEFS and OPTIONDEFS; the only
  100.     reason for keeping them separate is to allow OSDEFS to be tabulated
  101.     as above.
  102.  
  103.     Option Flag    Explanation
  104.     -----------     -----------
  105.  
  106.     USE_PK        Use pk format font files.  This is preferred because
  107.             pk font files are smaller.
  108.     USE_GF        Use gf format font files.
  109.     BUTTONS        Put radio buttons on the right side of the window for
  110.             commonly used commands.
  111.     NOTOOL        Compile using raw X calls.
  112.     GREY        Use greyscale anti-aliasing for displaying shrunken
  113.             bitmaps.
  114.     PS_DPS        Use Display PostScript <TM> to display PostScript <TM>
  115.             specials.  Your system must have DPS for this to work.
  116.     PS_NEWS        Use the NeWS server to display PostScript specials.
  117.             Your system must have the NeWS include files and
  118.             libraries for this to compile; the xdvi binary can be
  119.             run with either a standard X server or the NeWS server,
  120.             but in the former case the code generated by PS_NEWS
  121.             will have no effect.
  122.     PS_GS        Use GhostScript <TM> to render PostScript specials.
  123.             Your system must have Ghostscript installed for this
  124.             to work.  Versions earlier than 2.6.1 have not been
  125.             tested with xdvi.
  126.     MAKEPK        If a font is not found, then try to call Metafont to
  127.             create the font.  When using this option, remember to
  128.             set the paths in MakeTeXPK correctly for your site,
  129.             and be sure that the destination directory for
  130.             MakeTeXPK appears in your DEFAULT_FONT_PATH variable.
  131.             To have PostScript<TM>-like fonts made as well, see
  132.             the package gsftopk distributed with xdvi.
  133.     MAKEPKCMD=\"/usr/local/tex/bin/MakeTeXPK\" Same as the above, but this
  134.             variant explicitly declares which command to use to
  135.             create the font.
  136.     A4        Use European size paper by default.
  137.     TEXXET        Enables op-codes 250 and 251 (used for right-to-left
  138.             languages).
  139.     BDPI        Default number of pixels per inch to use.
  140.             Don't forget to make corresponding changes to
  141.             DEFAULT_FONT_SIZES.
  142.     ALTFONT        Default font to use if the font named in the dvi file
  143.             cannot be found.  Can be set to NULL.  By default,
  144.             it is "cmr10".
  145.     XDVIFONTS_ONLY    Never check the TEXFONTS environment variable.
  146.             Normally xdvi checks TEXFONTS if the XDVIFONTS variable
  147.             is not set.  This option is recommended if the version
  148.             of TeX in use requires that the TEXFONTS variable be
  149.             set.  See the relevant paragraph in xdvi_man.sed for
  150.             more details.  This option turns off that paragraph.
  151.     SEARCH_SUBDIRECTORIES Enable recursive searching of subdirectories for
  152.             font files (* and ** specifiers).
  153.             This also enables the TEXFONTS_SUBDIR environment
  154.             variable and the DEFAULT_SUBDIR_PATH makefile variable.
  155.     NOQUERY        Set this if you have trouble compiling the definition
  156.             of drawingWidgetClass.
  157.  
  158.  
  159. SETTING THE FONT PATH
  160.  
  161.     Read the ENVIRONMENT section of xdvi_man.sed to determine the correct
  162.     default values for the XDVIFONTS and XDVISIZES environment variables.
  163.     Edit the Imakefile or Makefile and change the values of the make
  164.     variables DEFAULT_FONT_PATH and DEFAULT_FONT_SIZES to these values.
  165.     If your site uses virtual fonts, do the same thing with the
  166.     DEFAULT_VF_PATH variable.  Note that support of virtual fonts in xdvi
  167.     does not include support of built-in Postscript<tm> fonts.
  168.     Usually you will want to use the same font files as your printer;
  169.     given a choice, however, it has been suggested that write-white
  170.     fonts look better.
  171.  
  172.     (Note:  If you are using both imake and the "/*" or "/**" syntax for
  173.         recursive searching of subdirectories, you should enclose
  174.         the string in quotes, since /* marks the beginning of a C
  175.         comment, and the Imakefile is processed by cpp.)
  176.  
  177.  
  178. COMMON PROBLEMS WHEN COMPILING
  179.  
  180.     Some early versions of `make' may complain and abort if the file
  181.     Makefile.cfg does not exist.  If this is the case, do:
  182.                 touch Makefile.cfg
  183.                 make config
  184.     before running make.  (If `make' complains but continues by running
  185.     ./mkconfig, then this is OK.)
  186.  
  187.     If you get the error that the #include file <stdlib.h> does not exist,
  188.     then you should include -DX_NOT_STDC_ENV in your OSDEFS variable.
  189.     In X11R5 or later this problem should not occur.
  190.  
  191. ================================================================
  192.  
  193.     This program is the combined work of many people, including but not
  194. restricted to:
  195.     Eric Cooper, CMU
  196.     Bob Scheifler, MIT LCS
  197.     Paal Kvamme, Norwegian Institute of Technology
  198.     H\aa vard Eidnes, Norwegian Institute of Technology
  199.     Mark Eichin, MIT SIPB
  200.     Paul Vojta, UC Berkeley
  201.     Jeffrey Lee, U of Toronto
  202.     Donald Richardson, Clarkson Univ.
  203.     Ricardo Telichevesky, MIT
  204.     Luis Miguel Silveira, MIT
  205.  
  206. At the present time, the person to send bug reports to is Paul Vojta,
  207.     vojta@math.berkeley.edu.
  208. When doing so, please specify hardware and OS version, OPTIONDEFS
  209. and OSDEFS settings in the Makefile, and anything else that may be
  210. relevant.  Be sure you've checked the FAQ first, especially for questions
  211. regarding searching for font files.
  212.  
  213. This software has been tested on Sparc (SunOS 4.1.3), Sun3 (SunOS 4.1.3),
  214. Intel 486 (Linux 1.0), and RS6000 (AIX), although not all of these were
  215. running R6.
  216.  
  217. In addition to the various comp.sources.x archives, current versions of this
  218. program can also be obtained via anonymous ftp from the following location:
  219.     ftp.x.org        file contrib/applications/xdvi.tar.Z
  220.     [198.112.44.100]
  221. To ease the load on ftp.x.org, you may also check other X archives, for example:
  222.     gatekeeper.dec.com    file pub/X11/contrib/applications/xdvi.tar.Z
  223.     [16.1.0.2]
  224. For those who like to live on the bleeding edge, the latest and greatest
  225. beta test version is often available on:
  226.     math.berkeley.edu    pub/Software/TeX/xdvi_beta.tar.Z
  227.     [128.32.183.94]    
  228.  
  229. Paul Vojta, 11 May 1994
  230.  
  231. ================================================================
  232.  
  233. Note for IBM RS6000 users:  some of the libraries are in non-obvious places:
  234.  
  235.     libXmu    /usr/lpp/X11/Xamples/lib/Xmu/libXmu.a
  236.     libXaw    /usr/lpp/X11/Xamples/lib/Xaw/libXaw.a
  237.  
  238. These should be moved to /usr/lib or some more reasonable place (or use
  239. symlinks), and ditto for the include files, which are initially placed
  240. in /usr/lpp/X11/Xamples/include.
  241.  
  242. ================================================================
  243.  
  244. Notes of historical nature follow.  Most recent changes are listed at the end
  245. of the file.
  246.  
  247. ================================================================
  248.  
  249. This directory contains a version of xdvi capable of reading GF, PXL
  250. and PK font files. This version of xdvi is based on the source that
  251. "came with" X v10r3. Xdvi was modified by Paal Kvamme at the Norwegian
  252. Institute of Technology, based on the modifications I had made to
  253. dviimp (a dvi to ImPress converter). This code was again more or less
  254. directly translated from the web source of PKtoPX.
  255.  
  256. If you discover (and fix) any bugs in this code, please notify me, so
  257. I can make the corresponding changes myself.
  258.  
  259. ---------
  260. H}vard Eidnes    (TeXish: H\aa vard Eidnes)
  261. Division of Computer Science
  262. Norwegian Institute of Technology
  263.  
  264. E-Mail: h_eidnes%vax.runit.unit.uninett@nta-vax.arpa
  265. ================================================================
  266. Also has path search added by Mark Eichin, looks in TEXFONTS
  267. ================================================================
  268.  
  269. ================================================================
  270. Additional notes:
  271.     X11 version now works on the IBM PC/RT as well as VAX.
  272.             [eichin:19880313.1330EST]
  273. ================================================================
  274. *MORE* fixes (for athena release locker) [eichin:19880722.2058EST]
  275. Fixes:
  276.     narrow vertical and horizontal lines no longer disappear.
  277.     bogus underlining (which usually occured on even sample sizes
  278. of odd sized characters) no longer occurs.
  279.     -S number (or typing number followed by S) will adjust the
  280. sampling fraction; 0 is special cased to mean if anything in the
  281. sampled zone is set, set the sample, else clear it. Interesting to
  282. experiment with, though not useful for reading (the default value of 3
  283. is just right.)
  284.     -display and -geometry arguments work (so do old style forms,
  285. though they were broken before)
  286.     fixed one of the PK debugging messages to print the correct
  287. font name instead of printing the pointer as text.
  288.     included Ken Raeburn <raeburn>'s changes to support multiple
  289. screens.
  290. ================================================================
  291. More changes:
  292.  
  293.     1.  Incorporated the bitmap under a viewport widget using the toolkit
  294.     (X11 only);
  295.     2.  Added an icon and icon geometry arguments (X11 only);
  296.     3.  Supported window resizing;
  297.     4.  Added a 'c' option to move whatever is currently under the cursor to
  298.     the center of the window;
  299.     5.  Added an 'R' option to reread the .dvi file, and added logic to make
  300.     'R' happen automatically whenever any part of the window is exposed
  301.     and the dvi file changes (so that you can iconify xdvi, run tex,
  302.     deiconify xdvi, and voila!);
  303.     6.  Added a 'magnifying glass':  when you push a button, a window pops
  304.     up, showing the region of the page, unshrunk;
  305.     7.  Added support for gf fonts;
  306.     8.  Upgraded font searching (at our site we use /usr/custom/tex82/gf
  307.     for gf fonts, /usr/custom/tex82/pk for pk fonts, etc.);
  308.     9.  Made numerous internal changes (removed all the lint I could,
  309.     made unshrunk bitmaps permanently resident, which speeds up size
  310.     changing, made table.h necessary only for pxl.h, split up the source
  311.     file into xdvi.c, dvi.c, gf.c, pxl.c, and pk.c, made shrinking occur
  312.     relative to the character's hot point, etc.)
  313.    10.  The program reads SIGIO signals and processes incoming events
  314.     immediately, so that it can stop displaying things that would be
  315.     erased anyway.  If these interrupts are not coming through, then
  316.     it also checks for incoming events every several dozen characters
  317.     displayed.
  318.    11.  Further split up dvi.c into dvi_init.c and dvi_draw.c; added
  319.     compilation options for various internal bitmap representations.
  320.     Fixed it so gcc won't give warnings, and so it works with R3 toolkit.
  321. --  Patchlevel 2:  --
  322.    12.  Added MAXCHARS compilation option.  Eliminated the nonsense with
  323.     generating table.h.
  324. --  Patchlevel 3:  --
  325.    13.  Added -altfont command line option and SYSV compilation option.
  326. ================================================================================
  327.  
  328. 4/1989  Modified for System V boxes. -DSYSV compiler option.
  329.  
  330. Donald Richardson, donr@crystal.mie.clarkson.edu
  331.  
  332. ================================================================================
  333. --  Patchlevel 4:  --
  334.    14.  Removed MAXCHARS compilation option.  It's automatic now.  Made X10
  335.     scrolling smoother.  Implemented the moving magnifying glass.
  336. --  Patchlevel 5:  --
  337.    15.  Implemented compilation without the toolkit, as well as scrollbars
  338.     and tpic support in X10.  Also this version should work with color
  339.     VAXstations, although overstrike characters will come out incorrectly.
  340.    16.  Fixed a bug in gf reading routines:  specials at the beginning of
  341.     a character def. were not being processed.  Thanks to
  342.     kevin@amath.washington.edu for a bug report and fix.
  343.    17.  Added 'k' keystroke.
  344. --  Patchlevel 6:  --
  345.    18.  Added buttons on the right side of the window.
  346.    19.  Added -pagewidth and -pageheight command line options and A4
  347.     compilation option.
  348.    20.  Added a yet more robust font finding algorithm.
  349. --  Patchlevel 7:  --
  350.    21.  Replaced -pagewidth and -pageheight options with -paper.
  351. --  Patchlevel 8:  --
  352.    22.  Added compatibility for X11R4 and VMS.  Fixed up alignment of rules.
  353. --  Patchlevel 9:  --
  354.    23.    Removed obsolete '#' and '=' options from the X11 version:  they
  355.     interfere with emacs.
  356. --  Patchlevel 10: --
  357.    24.    Implemented arrow keys, expert mode, searching for the font's actual
  358.     size first, the -[xy]offset and -sw options, and numerous bug fixes.
  359. --  Patchlevel 11: --
  360.    25.    Implemented recursive searching for font files in subdirectories.
  361.    26.    Changed +sw to -hushspecials and implemented -hush.
  362.    27.    Modified mksedscript so that the man page comes out neater.
  363.    28.  Added a -keep option and resource to match the `k' keystroke.
  364. --  Patchlevel 12: --
  365.    29.  Implemented virtual fonts (this does not include built-in
  366.     Postscript<tm> fonts!!!).
  367.    30.    X11R5 support, and numerous bug fixes.
  368. --  Patchlevel 13: --
  369.    31.  Added support for TeXXeT.
  370. --  Patchlevel 14: --
  371.    32.  Added support for greyscale anti-aliasing.
  372. --  Patchlevel 15: --
  373.    33.  Added support for MakeTeXPK, as in dvips.
  374. --  Patchlevel 16: --
  375.    34.    In the code for greyscale anti-aliasing, try to allocate a colormap
  376.     so that GXor operations can be used for drawing.  Also interpolate
  377.     between foreground and background colors.
  378. --  Patchlevel 17: --
  379.    35.    Fixed some bugs in the greyscale code.
  380.    36.    Implemented an environment variable for the MakeTeXPK script.
  381.    37.    Replaced mksedscript with a script using /bin/sh.
  382. --  Patchlevel 18: --
  383.    38.    Implemented checking of checksums and the -hushchecksums option.
  384.    39.  Implemented non-square magnifying glasses.
  385.    40.    Removed support for X10.
  386.    41.    Removed support for the pxl font format.
  387.    42.    Added support for PostScript specials via DPS or NeWS or gs.
  388.  
  389. Paul Vojta, vojta@math.berkeley.edu
  390.